home *** CD-ROM | disk | FTP | other *** search
/ TeX 1995 July / TeX CD-ROM July 1995 (Disc 1)(Walnut Creek)(1995).ISO / biblio / bibtex / utils / bibclean / bibclean.h < prev    next >
Text File  |  1992-11-16  |  7KB  |  140 lines
  1. /* WARNING: Do NOT edit this file.  It was created automatically
  2.    with the command "make bibclean.h" by beebe@plot79.math.utah.edu
  3.    in /u/sy/beebe/tex/bibclean on Tue Nov 17 14:14:02 MST 1992 */
  4.  
  5.     "Command-line switches may be abbreviated to a unique leading\n",
  6.     "prefix, and letter case is not significant.  All options are parsed\n",
  7.     "before any input bibliography files are read, no matter what their\n",
  8.     "order on the command line.  Options that correspond to a yes/no\n",
  9.     "setting of a flag have a form with a prefix \"no-\" to set the flag\n",
  10.     "to no.  For such options, the last setting determines the flag\n",
  11.     "value used.  This is significant when options are also specified in\n",
  12.     "initialization files (see the INITIALIZATION FILES manual section).\n",
  13.     "\n",
  14.     "-author   Display an author credit on stderr.  Sometimes an\n",
  15.     "          executable program is separated from its documentation\n",
  16.     "          and source code; this option provides a way to recover\n",
  17.     "          from that.\n",
  18.     "\n",
  19.     "-error-log filename\n",
  20.     "          Redirect stderr to the indicated file, which will then\n",
  21.     "          contain all of the error and warning messages.  This\n",
  22.     "          option is provided for those systems that have difficulty\n",
  23.     "          redirecting stderr.\n",
  24.     "\n",
  25.     "-help or -?\n",
  26.     "          Display a help message on stderr, giving a usage\n",
  27.     "          description, similar to this section of the manual pages.\n",
  28.     "\n",
  29.     "-init-file filename\n",
  30.     "          Provide an explicit value pattern initialization file.\n",
  31.     "          It will be processed after any system-wide and job-wide\n",
  32.     "          initialization files found on the PATH (for VAX VMS,\n",
  33.     "          SYS$SYSTEM) and BIBINPUTS search paths, respectively, and\n",
  34.     "          may override them.  It in turn may be overridden by a\n",
  35.     "          subsequent file-specific initialization file.  The\n",
  36.     "          initialization file name can be changed at compile time,\n",
  37.     "          but defaults to .bibcleanrc on UNIX, and to bibclean.ini\n",
  38.     "          elsewhere.  For further details, see the INITIALIZATION\n",
  39.     "          FILES manual section.\n",
  40.     "\n",
  41.     "-[no-]check-values\n",
  42.     "          With the positive form, apply heuristic pattern matching\n",
  43.     "          to value fields in order to detect possible errors (e.g.\n",
  44.     "          ``year = \"192\"'' instead of ``year = \"1992\"''), and issue\n",
  45.     "          warnings when unexpected patterns are found.\n",
  46.     "\n",
  47.     "          This checking is usually beneficial, but if it produces\n",
  48.     "          too many bogus warnings for a particular bibliography\n",
  49.     "          file, you can disable it with the negative form of this\n",
  50.     "          option.  Default: yes.\n",
  51.     "\n",
  52.     "-[no-]delete-empty-fields\n",
  53.     "          With the positive form, remove all key/value pairs for\n",
  54.     "          which the value is an empty string.  This is helpful in\n",
  55.     "          cleaning up bibliographies generated from text editor\n",
  56.     "          templates. Compare this option with -[no-]remove-OPT-\n",
  57.     "          prefixes described below.  Default: no.\n",
  58.     "\n",
  59.     "-[no-]file-position\n",
  60.     "          With the positive form, give detailed file position\n",
  61.     "          information in warning and error messages.  Default: no.\n",
  62.     "\n",
  63.     "-[no-]fix-initials\n",
  64.     "          With the positive form, insert a space after a period\n",
  65.     "          following author initials.  Default: yes.\n",
  66.     "\n",
  67.     "-[no-]fix-names\n",
  68.     "          With the positive form, reorder author and editor name\n",
  69.     "          lists to remove commas at brace level zero, placing first\n",
  70.     "          names or initials before last names.  Default: yes.\n",
  71.     "\n",
  72.     "-[no-]par-breaks\n",
  73.     "          With the negative form, a paragraph break (either a\n",
  74.     "          formfeed, or a line containing only spaces) is not\n",
  75.     "          permitted in value strings, or between key/value pairs.\n",
  76.     "          This may be useful to quickly trap runaway strings\n",
  77.     "          arising from mismatched delimiters.  Default: yes.\n",
  78.     "\n",
  79.     "-[no-]print-patterns\n",
  80.     "          With the positive form, print the value patterns read\n",
  81.     "          from initialization files as they are added to internal\n",
  82.     "          tables.  Use this option to check newly-added patterns,\n",
  83.     "          or to see what patterns are being used.\n",
  84.     "\n",
  85.     "          When bibclean is compiled with native pattern-matching\n",
  86.     "          code (the default), these patterns are the ones that will\n",
  87.     "          be used in checking value strings for valid syntax, and\n",
  88.     "          all of them are specified in initialization files, rather\n",
  89.     "          than hard-coded into the program.  For further details,\n",
  90.     "          see the INITIALIZATION FILES manual section.  Default:\n",
  91.     "          no.\n",
  92.     "\n",
  93.     "-[no-]read-init-files\n",
  94.     "          With the negative form, suppress loading of system-,\n",
  95.     "          user-, and file-specific initialization files.\n",
  96.     "          Initializations will come only from those files\n",
  97.     "          explicitly given by -init-file filename options.\n",
  98.     "          Default: yes.\n",
  99.     "\n",
  100.     "-[no-]remove-OPT-prefixes\n",
  101.     "          With the positive form, remove the ``OPT'' prefix from\n",
  102.     "          each key name where the corresponding value is not an\n",
  103.     "          empty string.  The prefix ``OPT'' must be entirely in\n",
  104.     "          upper-case to be recognized.  This option is for\n",
  105.     "          bibliographies generated with the help of the GNU Emacs\n",
  106.     "          BibTeX editing support, which generates templates with\n",
  107.     "          optional fields identified by the ``OPT'' prefix.\n",
  108.     "          Although the function M-x bibtex-remove-OPT normally\n",
  109.     "          bound to the keystrokes C-c C-o does the job, users often\n",
  110.     "          forget, with the result that BibTeX does not recognize\n",
  111.     "          the key name, and ignores the value string.  Compare this\n",
  112.     "          option with -[no-]delete-empty-fields described above.\n",
  113.     "          Default: no.\n",
  114.     "\n",
  115.     "-[no-]scribe\n",
  116.     "          With the positive form, accept input syntax conforming to\n",
  117.     "          the Scribe document system.  The output will be converted\n",
  118.     "          to conform to BibTeX syntax.  See the SCRIBE BIBLIOGRAPHY\n",
  119.     "          FORMAT manual section for further details.  Default: no.\n",
  120.     "\n",
  121.     "-[no-]trace-file-opening\n",
  122.     "          With the positive form, log in the error log file the\n",
  123.     "          names of all files which bibclean attempts to open.  Use\n",
  124.     "          this option to identify where initialization files are\n",
  125.     "          located.\n",
  126.     "\n",
  127.     "-[no-]warnings\n",
  128.     "          With the positive form, allow all warning messages.  The\n",
  129.     "          negative form is not recommended since it may mask\n",
  130.     "          problems that should be repaired.  Default: yes.\n",
  131.     "\n",
  132.     "-version  Display the program version number on stderr.  This will\n",
  133.     "          also include an indication of who compiled the program,\n",
  134.     "          the host name on which it was compiled, the time of\n",
  135.     "          compilation, and the type of string value matching code\n",
  136.     "          selected, when that information is available to the\n",
  137.     "          compiler.\n",
  138.     "\n",
  139.     (const char*)NULL,
  140.